/* Copyright (C) 2007-2008  klevgert  http://code.google.com/p/db4o-netbeans/

This file is part of the db4o-netbeans module suite.

db4o-netbeans is free software; you can redistribute it and/or modify it under
the terms of version 2 of the GNU General Public License as published
by the Free Software Foundation and as clarified by db4objects' GPL 
interpretation policy, available at
http://www.db4o.com/about/company/legalpolicies/gplinterpretation/
Alternatively you can write to db4objects, Inc., 1900 S Norfolk Street,
Suite 350, San Mateo, CA 94403, USA.

db4o-netbeans is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. */

package com.db4o.nb.api;

import java.beans.PropertyChangeListener;

/**
 * This is a service that host a database as service instance.
 * @author klevgert
 */
public interface Db4oServer {
  
  public static int STARTING = 1;
  public static int STARTED  = 2;
  public static int STOPPING = 3;
  public static int STOPPED  = 4;
  
  /**
   * Gets the database that is hosted by the server. 
   */
  public Db4oDatabase getDatabase();

  /**
   * Checks if the server is running
   */
  public boolean isStarted();

  /**
   * Gets the running state
   */
  public int getState();
  
  /**
   * Start the service
   */
  public void start();
  
  /**
   * Stop the service
   * @param forced   true, if forced termination is required, otherwise false
   */
  public void stop(boolean forced);

  /**
   * Add a listener for property changes.
   * @param listener   listener object to add.
   */
  public void addPropertyChangeListener(PropertyChangeListener listener);
  
  /**
   * Remove a previous added listener for property changes.
   * @param listener   listener object to remove
   */
  public void removePropertyChangeListener(PropertyChangeListener listener);
  
}
